home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Franz PD / Franz PD Disk #148 (1991-11)(Rhein-Sieg-Soft).zip / Franz PD Disk #148 (1991-11)(Rhein-Sieg-Soft).adf / Cross_Ref / CROSS_REF.dok < prev    next >
Text File  |  1991-11-09  |  7KB  |  192 lines
  1. CROSS_REF V1.2
  2.  
  3. Cross-Reference-Lister für GFA-BASIC Quellcodes
  4.  
  5. © 1991 by BluesBrothers
  6.  
  7. Michael Köpke           Rolf Herrmann
  8. Berliner Ring 5         Theresenstr. 16
  9. 6233 Kelkheim/Ts.       6233 Kelkheim/Ts.
  10.  
  11.  
  12. Das Programm ist Shareware
  13.  
  14. Das bedeutet:
  15. -------------
  16. Jeder dem es gefällt und der Spaß daran hat, darf und soll es
  17. anwenden. Es ist gestattet, das Programm frei zu kopieren und
  18. weiterzugeben. Die Verteilung über Public-Domain ist gestattet,
  19. solange es nicht in Geschäftemacherei ausartet. Sollte ein
  20. gewerblicher Einsatz geplant sein ( in Verlagen o.ä.) ist dies
  21. vorher mit den Autoren abzustimmen.
  22.  
  23. Als Aufwandsentschädigung bitten die Autoren um Übersendung von 
  24. DM 20,--. Wer das Programm nutzt ohne zu zahlen, dem soll der
  25. GURU schon beim booten erscheinen !
  26.  
  27. Wenn das Programm weitergegeben wird, darf das nur komplett
  28. geschehen, d.h. folgende Dateien müssen enthalten sein:
  29.  
  30.            CROSS_REF_V1_2A          - Hauptprogramm
  31.            CROSS_REF_V1_2A.info     - das Icon dazu
  32.            CROSS_REF_V1_2A.dok      - Programmanleitung
  33.            CROSS_REF_V1_2A.dok.info - das Icon dazu
  34.  
  35.  
  36. Das Programm wurde programmiert mit GFA-Basic 3.51 und compiliert
  37. mit dem GFA-Basic-Compiler 3.51.
  38.  
  39.  
  40. Wozu das ganze ???
  41. ------------------
  42.  
  43. Wozu brauche ich einen Cross-Reference-Lister für meine
  44. selbstentwickelten GFA-BASIC-Programme, ich bin doch sowieso
  45. gezwungen, meine Programmes strukturiert zu schreiben!
  46.  
  47. Im Prinzip richtig, aber...
  48.  
  49. ... irgendwann, insbesondere bei großen Projekten oder bei
  50. späteren Erweiterungen, wird es dann doch schwierig und
  51. zeitaufwendig, den eigenen Code zu durchblicken. Die Bedeutung
  52. einzelner Variablen ist in Vergessenheit geraten, wenn sie nicht
  53. sauber dokumentiert sind etc. Ganz zu schweigen von so bösen
  54. Sachen, wie absoluten Sprüngen im Programm (jaja, GOTO wurde
  55. komischerweise noch zugelassen und der eine oder andere D..
  56. benutzt es dann auch fleißig.)
  57.  
  58.  
  59. Und wer ist nicht froh, nach wochenlanger Entwicklungsarbeit
  60. seine Version 1.0 fertigzuhaben; der Gedanke daran, das Programm
  61. anschließend sauber und umfassend zu dokumentieren, kann ganz
  62. schön ätzend sein. Die wichtigsten Routinen und Variablen sind ja
  63. im Source-Code schön beschrieben!
  64.  
  65. Hier hakt CROSS-REF ein. Es analysiert das Programm, filtert alle
  66. Procedures, Functions, Marken und Variablen heraus und gibt sie
  67. zusammen mit den Zeilennummern, in denen sie verwendet werden,
  68. aus. Sofern Kommentare im Programm Verwendung finden, werden sie
  69. übernommen. Fehlende Kommentare können ergänzt werden.
  70.  
  71.  
  72. Bedienung des Programms
  73. -----------------------
  74.  
  75. Das Programm wird durch anklicken des Programm-Icons von der
  76. Workbench gestartet und öffnet einen eigenen Screen. Es wird
  77. vollständig mit der Maus bedient. Hierzu dienen verschiedene
  78. Schalter, auf die im folgenden eingegangen werden soll:
  79.  
  80. Im rechten oberen Teil befinden sich zwei Buttons, die das
  81. gewünschte Ausgabemedium bestimmen. Durch Anklicken der Buttons
  82. wird umgeschaltet zwischen Ausgabe in eine Datei oder direkt auf
  83. einen angeschlossen Drucker. Der hellrote Button ist der jeweils
  84. aktivierte. Bei Ausgabe in eine Datei befindet sich diese im
  85. selben Verzeichnis wie der Quellcode; sie erhält die Endung
  86. ".CRL" und liegt im ASCII-Format vor. Stellen Sie bitte sicher,
  87. daß, wenn Sie auf Diskette schreiben, diese nicht
  88. schreibgeschützt ist und genügend freien Speicherplatz aufweist
  89. (es kommt durchaus vor, daß die komplette Ausgabe die Größe des
  90. Quellcodes übersteigt).
  91.  
  92. Im linken unteren Teil befinden sich drei Buttons, mit denen
  93. bestimmt wird, was analysiert werden soll. Es besteht die
  94. Möglichkeit Prozeduren und Funktionen, Variablen sowie Label zu
  95. verarbeiten. Es muß immer mindestens ein Button aktiviert
  96. (hellrot) sein.
  97.  
  98. Die vier Schalter in der linken oberen Ecke des Fensters dienen
  99. zur Steuerung des Programmablaufs.
  100.  
  101. 1. DATEI
  102. --------
  103. Nach Betätigung dieses Schalters erscheint ein Datei-Requester,
  104. mit dessen Hilfe der zu analysierende Source-Code ausgewählt
  105. wird. Der Source-Code muß im ASCII-Format vorliegen, zu erkennen
  106. an der Endung ".lst" oder ".stp"*). Andere Files werden
  107. abgewiesen.
  108.  
  109. Nach der erfolgreichen Auswahl wird der Dateiname rechts daneben
  110. angezeigt. Befindet sich der GFA-Source-Code im selben
  111. Verzeichnis, wird die Länge des Originalprogramms ebenfalls
  112. ausgegeben. Darunter erscheint nun die Statusmeldung "NEU
  113. GEWÄHLT".
  114.  
  115.  
  116.  
  117. 2. START
  118. --------
  119. Startet die Programm-Analyse. Das setzt natürlich voraus, daß
  120. vorher eine Datei ausgewählt wurde, siehe oben. Die Statusmeldung
  121. ändert sich in "IN ARBEIT". Nach Beendigung der Analyse ändert
  122. sie sich wiederum in "AUSGEWERTET".
  123.  
  124. 3. INFO
  125. -------
  126. Gibt Programm-Information und Copyright-Vermerk aus.
  127.  
  128. 4. ENDE
  129. -------
  130. Beendet das Programm und kehrt zur Workbench zurück.
  131.  
  132.  
  133. AUSGABEFENSTER
  134. --------------
  135.  
  136. Im rechten unteren Teil des Bildschirms befindet sich das
  137. Ausgabefenster. Hier können sie den jeweiligen Stand des
  138. Programm-Ablaufs verfolgen. Nach Abarbeitung wird hierin eine
  139. kurze Statistik mit den wichtigsten Kenndaten des Programms
  140. ausgegeben.
  141.  
  142.  
  143. KOMMENTIERUNG
  144. -------------
  145.  
  146. Im nächsten Programmschritt erfolgt die Dokumentation. Hierzu
  147. öffnet sich ein neues Fenster, in dem in der Reihenfolge
  148. Prozeduren - Funktionen - Variablen - Marken jeweils 40 Zeichen
  149. Kommentar pro Element eingefügt werden können. Die Auswahl
  150. erfolgt durch Anklicken des gewünschten Elements; dieses kann in
  151. der Editierzeile weiter unten bearbeitet werden. Die Liste
  152. innerhalb des Auswahlfensters kann auf übliche Weise mit
  153. Scrollbars bewegt werden. Anklicken des OK-Gadgets schaltet in
  154. der o.g. Reihenfolge weiter. 
  155.  
  156. Nach Beendigung der Eingaben werden die Kommentare in einer
  157. weiteren Datei mit der Endung ".com" in dem Verzeichnis des
  158. Source-Files abgelegt. Bei einer späteren Analyse des selben
  159. Programmes können sie dann wieder Verwendung finden; findet
  160. CROSS-REF ein passendes ".com"-File im selben Verzeichnis, werden
  161. die früher eingegebenen Kommentare, wenn möglich, zugemischt.
  162.  
  163.  
  164. *) WAS IST EIN ".STP"-FILE ?
  165.    -------------------------
  166.  
  167. Ein mit dem "STRIPPER" erzeugtes File, ganz einfach!
  168. Der Stripper ist ein kleines Tool, welches sämtliche Kommentare
  169. aus einem Sourcecode entfernt. Dies ist zum Beispiel dann
  170. sinnvoll, wenn Source-Codes weitergegeben werden und man es dem
  171. potentiellen Anwender erschweren will, im Programm rumzudoktern.
  172. Außerdem werden gut kommentierte Files locker um 30-40 % kleiner.
  173.  
  174.  
  175. Jeder ehrliche Anwender, der sich als CROSS-REF-User registrieren
  176. läßt, erhält neben der geplanten erweiterten Version von CROSS-
  177. REF den STRIPPER als Bonus kostenlos zugeschickt. Soll noch mal
  178. einer sagen, sich registrieren lassen lohnt sich nicht!
  179.  
  180.  
  181. Die BluesBrothers wünschen viel Erfolg bei der Programmierung mit
  182. GFA-BASIC und hoffen, daß dieses Utilitie dazu beiträgt, das
  183. Leben des hartgeprüften Programmierers etwas zu erleichtern.
  184.  
  185. Sofern sie Wünsche und Anregungen zu CROSS-REF haben, lassen Sie
  186. es uns wissen. Wir werden es nach Möglichkeit bei späteren
  187. Updates berücksichtigen.
  188.  
  189.  
  190. Kelkheim/Ts., im September 1991
  191.  
  192. - Michael Köpke - Rolf Herrmann -